<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>OrbbecSDK: ob::Config Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="orbbec_icon.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OrbbecSDK
   &#160;<span id="projectnumber">1.8.3</span>
   </div>
   <div id="projectbrief">OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceob.html">ob</a></li><li class="navelem"><a class="el" href="classob_1_1Config.html">Config</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classob_1_1Config-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ob::Config Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classob_1_1Config.html" title="Config class for configuring pipeline parameters. ">Config</a> class for configuring pipeline parameters.  
 <a href="classob_1_1Config.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="Pipeline_8hpp_source.html">Pipeline.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acf833ba3b0f52198fed44a7fad39b566"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#acf833ba3b0f52198fed44a7fad39b566">Config</a> ()</td></tr>
<tr class="memdesc:acf833ba3b0f52198fed44a7fad39b566"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new <a class="el" href="classob_1_1Config.html" title="Config class for configuring pipeline parameters. ">Config</a> object.  <a href="#acf833ba3b0f52198fed44a7fad39b566">More...</a><br /></td></tr>
<tr class="separator:acf833ba3b0f52198fed44a7fad39b566"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a454e17debb33d61a8847c28e5e36ae98"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#a454e17debb33d61a8847c28e5e36ae98">~Config</a> () noexcept</td></tr>
<tr class="memdesc:a454e17debb33d61a8847c28e5e36ae98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the <a class="el" href="classob_1_1Config.html" title="Config class for configuring pipeline parameters. ">Config</a> object.  <a href="#a454e17debb33d61a8847c28e5e36ae98">More...</a><br /></td></tr>
<tr class="separator:a454e17debb33d61a8847c28e5e36ae98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad2606c8e340bf88bb836fc94927147b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#aad2606c8e340bf88bb836fc94927147b">enableStream</a> (std::shared_ptr&lt; <a class="el" href="classob_1_1StreamProfile.html">StreamProfile</a> &gt; streamProfile)</td></tr>
<tr class="memdesc:aad2606c8e340bf88bb836fc94927147b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable a stream to be used in the pipeline.  <a href="#aad2606c8e340bf88bb836fc94927147b">More...</a><br /></td></tr>
<tr class="separator:aad2606c8e340bf88bb836fc94927147b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd567dae35d849607594adb8ce143638"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#afd567dae35d849607594adb8ce143638">enableAllStream</a> ()</td></tr>
<tr class="memdesc:afd567dae35d849607594adb8ce143638"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable all streams to be used in the pipeline.  <a href="#afd567dae35d849607594adb8ce143638">More...</a><br /></td></tr>
<tr class="separator:afd567dae35d849607594adb8ce143638"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e3fcf7f5a0efc7b928409c19dd03dc9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#a5e3fcf7f5a0efc7b928409c19dd03dc9">disableStream</a> (<a class="el" href="ObTypes_8h.html#a4372502297ded5d6e6ee8db1d71d69d2">OBStreamType</a> streamType)</td></tr>
<tr class="memdesc:a5e3fcf7f5a0efc7b928409c19dd03dc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable a stream to be used in the pipeline.  <a href="#a5e3fcf7f5a0efc7b928409c19dd03dc9">More...</a><br /></td></tr>
<tr class="separator:a5e3fcf7f5a0efc7b928409c19dd03dc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad03b2517ffaca641ce78978a5f7e8b0d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#ad03b2517ffaca641ce78978a5f7e8b0d">disableAllStream</a> ()</td></tr>
<tr class="memdesc:ad03b2517ffaca641ce78978a5f7e8b0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable all streams to be used in the pipeline.  <a href="#ad03b2517ffaca641ce78978a5f7e8b0d">More...</a><br /></td></tr>
<tr class="separator:ad03b2517ffaca641ce78978a5f7e8b0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a618200abd674c33551eb6c3311d33b73"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#a618200abd674c33551eb6c3311d33b73">setAlignMode</a> (<a class="el" href="ObTypes_8h.html#ade914070120de80d4338ee74e73dc9d5">OBAlignMode</a> mode)</td></tr>
<tr class="memdesc:a618200abd674c33551eb6c3311d33b73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the alignment mode.  <a href="#a618200abd674c33551eb6c3311d33b73">More...</a><br /></td></tr>
<tr class="separator:a618200abd674c33551eb6c3311d33b73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3755c840dc4e9b1be9195d9b68936c78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#a3755c840dc4e9b1be9195d9b68936c78">setDepthScaleRequire</a> (bool enable)</td></tr>
<tr class="memdesc:a3755c840dc4e9b1be9195d9b68936c78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether the depth needs to be scaled after setting D2C.  <a href="#a3755c840dc4e9b1be9195d9b68936c78">More...</a><br /></td></tr>
<tr class="separator:a3755c840dc4e9b1be9195d9b68936c78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a671ffb5fa3e62388f3e62b31bed22d56"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#a671ffb5fa3e62388f3e62b31bed22d56">setD2CTargetResolution</a> (uint32_t d2cTargetWidth, uint32_t d2cTargetHeight)</td></tr>
<tr class="memdesc:a671ffb5fa3e62388f3e62b31bed22d56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the D2C target resolution.  <a href="#a671ffb5fa3e62388f3e62b31bed22d56">More...</a><br /></td></tr>
<tr class="separator:a671ffb5fa3e62388f3e62b31bed22d56"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:af9f0f1adbd5baee7830839447205af8d"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Config.html#af9f0f1adbd5baee7830839447205af8d">Pipeline</a></td></tr>
<tr class="separator:af9f0f1adbd5baee7830839447205af8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classob_1_1Config.html" title="Config class for configuring pipeline parameters. ">Config</a> class for configuring pipeline parameters. </p>
<p>The <a class="el" href="classob_1_1Config.html" title="Config class for configuring pipeline parameters. ">Config</a> class provides an interface for configuring pipeline parameters. </p>

<p>Definition at line <a class="el" href="Pipeline_8hpp_source.html#l00191">191</a> of file <a class="el" href="Pipeline_8hpp_source.html">Pipeline.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acf833ba3b0f52198fed44a7fad39b566"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ob::Config::Config </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct a new <a class="el" href="classob_1_1Config.html" title="Config class for configuring pipeline parameters. ">Config</a> object. </p>

</div>
</div>
<a class="anchor" id="a454e17debb33d61a8847c28e5e36ae98"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ob::Config::~Config </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destroy the <a class="el" href="classob_1_1Config.html" title="Config class for configuring pipeline parameters. ">Config</a> object. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aad2606c8e340bf88bb836fc94927147b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Config::enableStream </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classob_1_1StreamProfile.html">StreamProfile</a> &gt;&#160;</td>
          <td class="paramname"><em>streamProfile</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable a stream to be used in the pipeline. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">streamProfile</td><td>The stream configuration to be enabled </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="afd567dae35d849607594adb8ce143638"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Config::enableAllStream </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable all streams to be used in the pipeline. </p>

</div>
</div>
<a class="anchor" id="a5e3fcf7f5a0efc7b928409c19dd03dc9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Config::disableStream </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="ObTypes_8h.html#a4372502297ded5d6e6ee8db1d71d69d2">OBStreamType</a>&#160;</td>
          <td class="paramname"><em>streamType</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disable a stream to be used in the pipeline. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">streamType</td><td>The stream configuration to be disabled </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ad03b2517ffaca641ce78978a5f7e8b0d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Config::disableAllStream </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disable all streams to be used in the pipeline. </p>

</div>
</div>
<a class="anchor" id="a618200abd674c33551eb6c3311d33b73"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Config::setAlignMode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="ObTypes_8h.html#ade914070120de80d4338ee74e73dc9d5">OBAlignMode</a>&#160;</td>
          <td class="paramname"><em>mode</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the alignment mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">mode</td><td>The alignment mode </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a3755c840dc4e9b1be9195d9b68936c78"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Config::setDepthScaleRequire </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set whether the depth needs to be scaled after setting D2C. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>Whether scaling is required </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a671ffb5fa3e62388f3e62b31bed22d56"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Config::setD2CTargetResolution </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>d2cTargetWidth</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>d2cTargetHeight</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the D2C target resolution. </p>
<p>The D2C target resolution is applicable to cases where the color stream is not enabled using the OrbbecSDK and the depth needs to be D2C.</p>
<dl class="section note"><dt>Note</dt><dd>When you use OrbbecSDK to enable the color stream, you also use this interface to set the D2C target resolution. The configuration of the enabled Color stream is preferred for D2C.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">d2cTargetWidth</td><td>The D2C target width resolution </td></tr>
    <tr><td class="paramname">d2cTargetHeight</td><td>The D2C target height resolution </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="af9f0f1adbd5baee7830839447205af8d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classob_1_1Pipeline.html">Pipeline</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="Pipeline_8hpp_source.html#l00256">256</a> of file <a class="el" href="Pipeline_8hpp_source.html">Pipeline.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/root/libobsensor/include/libobsensor/hpp/<a class="el" href="Pipeline_8hpp_source.html">Pipeline.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 24 2023 10:56:17 for OrbbecSDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
